Skip to content

Update GitLab integration documentation#1160

Merged
nrichers merged 1 commit intomainfrom
nrichers/sc-14487/update-gitlab-integration-docume
Feb 6, 2026
Merged

Update GitLab integration documentation#1160
nrichers merged 1 commit intomainfrom
nrichers/sc-14487/update-gitlab-integration-docume

Conversation

@nrichers
Copy link
Collaborator

@nrichers nrichers commented Feb 6, 2026 •
edited
Loading

Pull Request Description

What and why?

Updates GitLab integration documentation to match the current UI and adds a complete example for synchronizing models with GitLab.

Changes:

  • Updated GitLab section in configure-connections.qmd with revised description and field help text
  • Added new "Synchronize models with GitLab" section to integrations-examples.qmd following the AWS SageMaker/Bedrock pattern
  • Added configuration screenshot showing the GitLab connection dialog

How to test

Check the live preview:

What needs special review?

  • Verify the GitLab example steps match current UI behavior

Dependencies, breaking changes, and deployment notes

None

Release notes

Added documentation for configuring GitLab connections and synchronizing models with GitLab model registry. Learn more

Checklist

  • What and why
  • Screenshots or videos (Frontend)
  • How to test
  • What needs special review
  • Dependencies, breaking changes, and deployment notes
  • Labels applied
  • PR linked to Shortcut
  • Unit tests added (Backend)
  • Tested locally
  • Documentation updated (if required)
  • Environment variable additions/changes documented (if required)

@github-actions
Copy link
Contributor

github-actions bot commented Feb 6, 2026

Pull requests must include at least one of the required labels: internal (no release notes required), highlight, enhancement, bug, deprecation, documentation. Except for internal, pull requests must also include a description in the release notes section.

@github-actions
Copy link
Contributor

github-actions bot commented Feb 6, 2026

PR Summary

This PR updates the documentation to include detailed instructions for integrating GitLab with the ValidMind model inventory. The changes outline how to synchronize the GitLab model registry with the ValidMind model inventory for comprehensive model tracking.

Key updates include:

  • Revised configuration details under the GitLab integration section, clarifying the usage of the GitLab project ID or path and the appropriate GitLab instance URL.
  • Updated instructions for obtaining and using a GitLab personal access token with the necessary api or read_api scopes.
  • A new section on synchronizing models with GitLab is added, which includes step-by-step guidelines on configuring the connection and linking models from the inventory to the GitLab connection. This involves actions such as adding a connection in the settings, testing the connection, and linking models through the provided UI.
  • A screenshot reference has been added to visualize the configuration dialog for better user guidance.

These enhancements ensure that users have a clear and comprehensive guide to set up and use the GitLab integration within the application.

Test Suggestions

  • Verify that the updated GitLab integration documentation correctly reflects the functionality in the application.
  • Test the 'Add Connection' workflow with GitLab to ensure the instructions match the UI behavior.
  • Ensure that the Test Connection and Link Model functionalities work as described in the guide.
  • Check that the screenshot (integrations-examples-gitlab.png) is properly displayed and correctly referenced in the documentation.

@nrichers nrichers added the internal Not to be externalized in the release notes label Feb 6, 2026
@nrichers nrichers requested a review from johnwalz97 February 6, 2026 19:16
@github-actions
Copy link
Contributor

github-actions bot commented Feb 6, 2026

Validate docs site

✓ INFO: A live preview of the docs site is available — Open the preview

@github-actions
Copy link
Contributor

github-actions bot commented Feb 6, 2026

Lighthouse check results

⚠️ WARN: Average accessibility score is 0.87 (required: >0.9) — Check the workflow run

Show Lighthouse scores

Folder depth level checked: 0

Commit SHA: b5a7d7e

Modify the workflow to check a different depth:

  • 0: Top-level navigation only — /index.html, /guide/guides.html, ...
  • 1: All first-level subdirectories — /guide/.html, /developer/.html, ...
  • 2: All second-level subdirectories — /guide/attestation/*.html, ...
Page Accessibility Performance Best Practices SEO
/developer/validmind-library.html 0.85 0.68 1.00 0.82
/get-started/get-started.html 0.85 0.70 1.00 0.73
/guide/guides.html 0.85 0.67 1.00 0.82
/index.html 0.93 0.61 1.00 0.82
/releases/all-releases.html 0.86 0.68 1.00 0.73
/support/support.html 0.91 0.58 1.00 0.82
/training/training.html 0.85 0.67 0.96 0.73

johnwalz97
johnwalz97 approved these changes Feb 6, 2026
View reviewed changes
Copy link
Contributor

@johnwalz97 johnwalz97 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this looks great to me

@nrichers nrichers merged commit 3e17e12 into main Feb 6, 2026
9 of 10 checks passed
@nrichers nrichers deleted the nrichers/sc-14487/update-gitlab-integration-docume branch February 6, 2026 19:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@johnwalz97 johnwalz97 johnwalz97 approved these changes

Assignees

No one assigned

Labels

internal Not to be externalized in the release notes

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@nrichers @johnwalz97